home *** CD-ROM | disk | FTP | other *** search
/ The PC-SIG Library 10 / The PC-Sig Library - Shareware for the IBM PC and Compatibles (PC-SIG)(Tenth Edition Disks 1-2804)(1991).iso / PC_SIGCD / 19 / 5 / DISK1959.ZIP / EDFIX2.DOC < prev    next >
Text File  |  1989-07-23  |  13KB  |  253 lines
  1.  
  2.       
  3.                               DOCUMENTATION FOR EDFIX2
  4.       
  5.                                     INTRODUCTION
  6.           EDFIX2 is a program that will read, edit, write, and transfer 
  7.       random-access files.  The file to be edited may be as long as two 
  8.       billion bytes, and each record may be as much as 2048 bytes long.
  9.           EDFIX2 will work on any file, even if the file is not truly a 
  10.       random-access file.  In a true random-access file, each record will have 
  11.       precisely the same length.  dBase files are not random-access files; 
  12.       each dBase data file begins with a header that is generally not the same 
  13.       length as any of the data records.  Still, EDFIX2 can manipulate dBase 
  14.       data files--except that EDFIX2 records will probably not match up with 
  15.       dBase records.  (The only thing that belongs in data files is data, and 
  16.       indexes, names, and all that other stuff belong elsewhere!)
  17.           You may also use EDFIX2 on spreadsheet files and files created by 
  18.       various other software packages.  Those files, too, are not random- 
  19.       access files (and don't pretend to be).
  20.           EDFIX2 can severely damage a file if you don't know what you're 
  21.       doing or make a mistake.  Make sure you always have backups of the file 
  22.       you're altering.
  23.           If you ask EDFIX2 to edit a file that doesn't exist (or has a length 
  24.       of zero), EDFIX2 will tell you so.  The file will be deleted if it had a 
  25.       length of zero.  You may not open and edit a file of length zero.
  26.       
  27.                                    SCREEN DISPLAY
  28.           If possible, EDFIX2 will display exactly what's in the file, ASCII 
  29.       text or not.  If the file data is stored (all or in part) in binary 
  30.       format, the screen display may be confusing; if EDFIX2 were to display 
  31.       some of those characters, the screen might clear, or lines might 
  32.       overwrite other lines.  So, some "dangerous" characters have been 
  33.       translated into another character.  Carriage returns are translated into 
  34.       a left-pointing arrow, and line feeds into a downward-pointing arrow.  
  35.       Other "dangerous" control codes (7, 11, 28-31) are translated into the 
  36.       graphics character 128 higher.
  37.           To see the ASCII or hexadecimal code for the character the cursor is 
  38.       on, press the ESC key.  At the bottom right of the screen, EDFIX2 will 
  39.       display the decimal and hexadecimal code for that character.
  40.       
  41.                                    RECORD LENGTH
  42.           If you don't know the record length of each record in the file, 
  43.       EDFIX2 can calculate some possibilities, based on the file length.  If 
  44.       there aren't very many possibilities (less than 5), EDFIX2 will suggest 
  45.       other possible record lengths that are nearly right--the file length is 
  46.       off by only one byte, which might be a CTRL-Z end-of-file marker.  If 
  47.       your data file ends with more than one sequential file EOF character, 
  48.       you may have to try some guesses of your own.
  49.           If your guess doesn't match the actual file length, EDFIX2 will tell 
  50.       you how many bytes are left over, and will ask you if you want to try 
  51.       another length.  Any leftover bytes will not be displayed by EDFIX2; you 
  52.       may see and alter only complete records, because allowing you to do 
  53.       otherwise might change the length of the data file.  Most programs will 
  54.       not take kindly to any unauthorized alterations in the file length, so 
  55.       that's why EDFIX2 won't allow you to change any final partial record.
  56.           If each of your records are followed by a carriage return or 
  57.       carriage return and line feed, you must treat those characters as a part 
  58.       of your record.  A 272-byte record followed by a carriage return is 
  59.       really a 273-byte record.  A 272-byte record followed by a carriage 
  60.       return and line feed is really a 274-byte record.
  61.  
  62.  
  63.                                              1
  64.  
  65.       
  66.           If you guess at a record length and see that you're wrong once the 
  67.       file has been opened, you may press CTRL-B and try another guess.
  68.       
  69.                                     EDITING DATA
  70.           Once you've entered the name of the data file and the associated 
  71.       record length, EDFIX2 will read the data file and display the first 20 
  72.       records.  Records past the end of the data file will be indicated by the 
  73.       legend "PAST EOF".  You won't be able to move to or edit those records.
  74.           The bottom portion of the screen will also display information about 
  75.       the current file.  You will be shown the file name, the number of 
  76.       records in the file, the current cursor position, and the current record 
  77.       number.  Depending on the situation, you may also be shown the current 
  78.       mode (insert or overtype) or an error message about the length of a 
  79.       record.  That part of the screen is also used for you to input the name 
  80.       of the transfer file and to display the status of the transfer.
  81.           You may move to or within a record or edit an existing record by 
  82.       using the following commands:
  83.       
  84.       COMMAND       RESULT
  85.       Up Arrow      Moves up one line to the previous record, if any.
  86.       CTRL-E        Same as Up Arrow.
  87.       Down Arrow    Moves down one line to the next record, if any.
  88.       CTRL-X        Same as Down Arrow.
  89.       Right Arrow   Moves one character to the right, if possible.
  90.       CTRL-D        Same as Right Arrow.
  91.       Left Arrow    Moves one character to the left, if possible.
  92.       CTRL-S        Same as Left Arrow.
  93.       Home          Moves to the start of the current record.
  94.       End           Moves to the end of the current record.
  95.       PG UP         Moves up 20 records (towards the file beginning).
  96.       CTRL-R        Same as PG UP.
  97.       PG DN         Moves down 20 records, if possible.
  98.       CTRL-C        Same as PG DN.
  99.       CTRL-PG UP    Moves to the beginning of the file.
  100.       CTRL-PG DN    Moves to the end of the file.
  101.       CTRL-J        Moves to whatever record number you like.
  102.       TAB           Moves to the next tab position (tabs set every 8).
  103.       CTRL-F        Same as TAB.
  104.       Backtab       Moves to the previous tab position.
  105.       CTRL-A        Same as Backtab.
  106.       DEL           Deletes the character at the current cursor position.
  107.       CTRL-G        Same as DEL.
  108.       Backspace     Deletes the character to the left and moves left.
  109.       INS           Changes mode from insert to delete and vice-versa.
  110.       CTRL-V        Same as INS.
  111.       CTRL-Y        Mark the current record as deleted (all ASCII 250s).
  112.       CTRL-B        Exit the file.  Don't save changes on the current screen.  
  113.                     Return to the 'record length' selection and make another 
  114.                     guess.
  115.       CTRL-P        Accept the next keystroke as a character, even if it is a 
  116.                     control code.  CTRL-P followed by ENTER will insert or 
  117.                     overtype a carriage return (ASCII 13) into the file.
  118.       ESC           Display the ASCII and hexadecimal value of the character 
  119.                     at the current cursor position.
  120.       
  121.           EDFIX2 starts in overtype mode: any character you type will replace 
  122.       the current character at the current cursor position.  When you press 
  123.       CTRL-V or the INS key, EDFIX2 will change to insert mode and any 
  124.  
  125.  
  126.                                              2
  127.  
  128.       
  129.       characters you type will be inserted within the line, moving existing 
  130.       characters to the right.  Pressing the INS key or CTRL-V again will 
  131.       change the mode back to overtype.
  132.           If you alter a record so the length doesn't match the record length 
  133.       you specified earlier, EDFIX2 will refuse to save the record until you 
  134.       add or delete enough characters to make the record the correct length.  
  135.       This is done because EDFIX2 cannot determine how to pad the record (or 
  136.       what data to throw away).
  137.           When you move up or down through the data file, EDFIX2 will check 
  138.       any records that move off the current screen.  If they have been altered 
  139.       and if they are the correct length, EDFIX2 will write them to the disk.  
  140.       If they have been altered and they are not the correct length, EDFIX2 
  141.       will notify you of the problem, position the cursor on the offending 
  142.       record, and tell you what the record's length is.
  143.           If you move far enough to the left or right, EDFIX2 will scroll 
  144.       horizontally in increments of 40 characters at a time.
  145.       
  146.                     INSERTING CONTROL CODES AND OTHER CHARACTERS
  147.           Pressing CTRL-P will tell EDFIX2 to accept the next character typed 
  148.       and (depending on whether you're in insert or overtype mode) insert that 
  149.       character into the current record or replace the current character with 
  150.       the one you type in.  If you're entering normal ASCII data, you won't 
  151.       need the CTRL-P command.
  152.           The CTRL-P command will thus allow you to insert any control code or 
  153.       graphics character into the data file.
  154.           There's an easy way to enter any particular code.  Rather than try 
  155.       to remember that ASCII 18 is control-R, you may hold down the ALT key 
  156.       and type the digits 018 on the numeric keypad.  Then release the ALT 
  157.       key, and EDFIX2 will act as though you had entered ctrl-R.  Just 
  158.       remember to enter CTRL-P first, and ASCII 18 will be put into the 
  159.       current record.
  160.       
  161.                           TRANSFERRING AND SAVING RECORDS
  162.           You may save your changes and exit to MSDOS by pressing CTRL-KD.  
  163.       You may save the changes on any screen by moving off that screen--for 
  164.       example, by pressing PG UP, PG DN, CTRL-PG UP, or CTRL-PG DN.  All 
  165.       changes on the current screen will also be saved when you press CTRL-KT 
  166.       (transfer records).
  167.           If you make a severe mistake while editing a record and you want to 
  168.       avoid saving the error, press CTRL-KQ.  Any changes on the current 
  169.       screen will not be saved, and EDFIX2 will return to MSDOS.
  170.           If you elect to transfer records, EDFIX2 will ask you for the name 
  171.       of the file to which you want to transfer the data.  If that file 
  172.       already exists, EDFIX2 will ask you if you want to overwrite it.  If 
  173.       not, you will return to edit mode.  If yes, the previous data file will 
  174.       be completely destroyed and the new data will replace it.  For that 
  175.       reason, you must not transfer records into the same file you are 
  176.       currently editing.  EDFIX2 will stop you from doing this: MSDOS will not 
  177.       permit you to erase a currently open file.
  178.           While transferring, EDFIX2 will show you how many records are in the 
  179.       original data file and how many have been read.  Records marked as 
  180.       deleted will not be transferred to the new file.  EDFIX2 marks records 
  181.       as deleted by replacing the full contents of the record with copies of 
  182.       ASCII character 250.  None of the original contents of the record will 
  183.       remain.  This is not the method used by dBase, but it is the method used 
  184.       by The CREATOR (tm, TNT Software).  Deleted records in dBase are marked 
  185.       by the presence of an asterisk in the first position of the record.
  186.       
  187.  
  188.  
  189.                                              3
  190.  
  191.       
  192.                                ADDITIONAL INFORMATION
  193.           EDFIX2 is shareware.  You may distribute copies of EDFIX2 so long as 
  194.       you don't ask people to pay you for their copy.  You may not sell EDFIX2 
  195.       without the written permission of TNT Software.  EDFIX2 is copyrighted 
  196.       and is the property of TNT Software.  It is NOT in the public domain.
  197.           If you like EDFIX2 and want to encourage the development (or 
  198.       enhancement) of more such software, please register your copy.  
  199.       Registered users will be sent a copy of the latest version, complete 
  200.       with full source code (Microsoft Quick BASIC).  The registration fee for 
  201.       EDFIX2 is $25.  Only registered users are entitled to support from 
  202.       T.N.T. Software.
  203.           Whether you're a registered user or not, we welcome your comments 
  204.       and suggestions for making EDFIX2 better.
  205.           If you're interested in other products of TNT Software, write or 
  206.       call:
  207.       
  208.                                  TNT SOFTWARE INC.
  209.                                ATTN: Bruce W. Tonkin
  210.                                34069 Hainesville Road
  211.                                 Round Lake IL 60073
  212.                                    (312) 223-8595
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.                                              4
  253.